| Fully Qualified Name: | Zend\Router\Http\TreeRouteStack |
| Extends: | SimpleRouteStack |
Tree search implementation.
| Name | Description | Defined By |
|---|---|---|
| __construct() | Create a new simple route stack. | SimpleRouteStack |
| addPrototype() | Add a prototype. | TreeRouteStack |
| addPrototypes() | Add multiple prototypes at once. | TreeRouteStack |
| addRoute() | addRoute(): defined by RouteStackInterface interface. | TreeRouteStack |
| addRoutes() | addRoutes(): defined by RouteStackInterface interface. | SimpleRouteStack |
| assemble() | assemble(): defined by \Zend\Router\RouteInterface interface. | TreeRouteStack |
| factory() | factory(): defined by RouteInterface interface. | TreeRouteStack |
| getBaseUrl() | Get the base URL. | TreeRouteStack |
| getPrototype() | Get a prototype. | TreeRouteStack |
| getRequestUri() | Get the request URI. | TreeRouteStack |
| getRoute() | Get a route by name | SimpleRouteStack |
| getRoutePluginManager() | Get the route plugin manager. | SimpleRouteStack |
| getRoutes() | Get the added routes | SimpleRouteStack |
| hasRoute() | Check if a route with a specific name exists | SimpleRouteStack |
| match() | match(): defined by \Zend\Router\RouteInterface | TreeRouteStack |
| removeRoute() | removeRoute(): defined by RouteStackInterface interface. | SimpleRouteStack |
| setBaseUrl() | Set the base URL. | TreeRouteStack |
| setDefaultParam() | Set a default parameter. | SimpleRouteStack |
| setDefaultParams() | Set a default parameters. | SimpleRouteStack |
| setRequestUri() | Set the request URI. | TreeRouteStack |
| setRoutePluginManager() | Set the route plugin manager. | SimpleRouteStack |
| setRoutes() | setRoutes(): defined by RouteStackInterface interface. | SimpleRouteStack |
Create a new simple route stack.
| Parameter Name | Type | Description |
|---|---|---|
| $routePluginManager | \RoutePluginManager |
Returns:
Add a prototype.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $route | mixed |
Returns: \TreeRouteStack
Add multiple prototypes at once.
| Parameter Name | Type | Description |
|---|---|---|
| $routes | \Traversable |
Returns: \TreeRouteStack
addRoute(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $route | mixed | |
| $priority | int |
Returns: \TreeRouteStack
addRoutes(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $routes | array|\Traversable |
Returns: \SimpleRouteStack
assemble(): defined by \Zend\Router\RouteInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $params | array | |
| $options | array |
Returns: mixed
factory(): defined by RouteInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable |
Returns: \SimpleRouteStack
Get the base URL.
Returns: string
Get a prototype.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: \RouteInterface|null
Get the request URI.
Returns: \HttpUri
Get a route by name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: \RouteInterface the route
Get the route plugin manager.
Returns: \RoutePluginManager
Get the added routes
Returns: \Traversable list of all routes
Check if a route with a specific name exists
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: bool true if route exists
match(): defined by \Zend\Router\RouteInterface
| Parameter Name | Type | Description |
|---|---|---|
| $request | \Request | |
| $pathOffset | int|null | |
| $options | array |
Returns: \RouteMatch|null
removeRoute(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: \SimpleRouteStack
Set the base URL.
| Parameter Name | Type | Description |
|---|---|---|
| $baseUrl | string |
Returns: self
Set a default parameter.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
Returns: \SimpleRouteStack
Set a default parameters.
| Parameter Name | Type | Description |
|---|---|---|
| $params | array |
Returns: \SimpleRouteStack
Set the request URI.
| Parameter Name | Type | Description |
|---|---|---|
| $uri | \HttpUri |
Returns: \TreeRouteStack
Set the route plugin manager.
| Parameter Name | Type | Description |
|---|---|---|
| $routePlugins | \RoutePluginManager |
Returns: \SimpleRouteStack
setRoutes(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $routes | array|\Traversable |
Returns: \SimpleRouteStack